Esx Settings Clusters Configuration DetailedValidationError

Esx Settings Clusters Configuration DetailedValidationError
Esx Settings Clusters Configuration DetailedValidationError

The SchemaValidationError schema contains details of validation errors for a property.

This schema was added in vSphere API 8.0.2.0.

JSON Example
{
    "hosts": [
        "string"
    ],
    "message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "type": "string",
    "pattern": "string",
    "expected_type": "string",
    "instance_id": "string",
    "property_name": "string",
    "maximum_length": 0,
    "minimum_length": 0,
    "maximum_value": 0,
    "minimum_value": 0,
    "dependency_error": {
        "required_value": "string",
        "current_value": "string",
        "possible_values": "string"
    },
    "component": "string",
    "group": "string",
    "key": "string",
    "path": "string",
    "required_property": "string"
}
array of string
hosts
Optional

If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here.

This property was added in vSphere API 8.0.2.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

message
Required

A user-friendly description of the error.

This property was added in vSphere API 8.0.2.0.

string
type
Required

The type of error. Additional information may be set for some types of errors.

For more information see: Esx Settings Clusters Configuration DetailedValidationError ErrorType.

This property was added in vSphere API 8.0.2.0.

string
pattern
Optional

The pattern the property is required to match.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.PATTERN_MISMATCH or Esx Settings Clusters Configuration DetailedValidationError ErrorType.PROPERTY_NAME_MISMATCH.

string
expected_type
Optional

The expected type of the property.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.INVALID_TYPE.

string
instance_id
Optional

The instance ID that was duplicated or is missing from the profile section.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.DUPLICATE_INSTANCE_ID or Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE.

string
property_name
Optional

The name of the property that holds the instance ID.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_INSTANCE_ID.

integer As int64 As int64
maximum_length
Optional

The maximum length allowed for a string or array property.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.MAX_STRING_LENGTH or Esx Settings Clusters Configuration DetailedValidationError ErrorType.MAX_ARRAY_LENGTH.

integer As int64 As int64
minimum_length
Optional

The minimum length allowed for a string or array property.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.MIN_STRING_LENGTH or Esx Settings Clusters Configuration DetailedValidationError ErrorType.MIN_ARRAY_LENGTH.

integer As int64 As int64
maximum_value
Optional

The maximum allowed value for a property.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.MAX_VALUE.

integer As int64 As int64
minimum_value
Optional

The minimum allowed value for a property.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.MIN_VALUE.

dependency_error
Optional

The dependency required by a union tag.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.INVALID_UNION_TAG or Esx Settings Clusters Configuration DetailedValidationError ErrorType.UNION_CASE_WITHOUT_UNION_TAG.

string
component
Optional

For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.SCHEMA_NOT_FOUND.

string
group
Optional

For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.SCHEMA_NOT_FOUND.

string
key
Optional

For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Esx Settings Clusters Configuration DetailedValidationError ErrorType.SCHEMA_NOT_FOUND.

string
path
Optional

The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_REQUIRED_PROFILE_KEY.

string
required_property
Optional

The name of the required property that is missing from the profile section for this instance/key.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or Esx Settings Clusters Configuration DetailedValidationError ErrorType.MISSING_REQUIRED_PROFILE_KEY.

Property Of